-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reworked documentation and formalize test suite #19
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Helveg
commented
Mar 22, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is to prevent a missing static path '_static'
error during build
Helveg
commented
Mar 22, 2024
Helveg
changed the title
Document test suite and specify dependencies
Reworked documentation
Mar 22, 2024
Helveg
changed the title
Reworked documentation
Reworked documentation and formalize test suite
Mar 22, 2024
Thanks for the excellent contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses 2 issues:
dashing
module docstring.Test suite
test
extra dependencies and add them to thedev
extra dependencies.pytest
suite exit as gracefully as possible with a failing exit code on Windows.pexpect
does not supportspawn
, and the alternative cross-platform APIpexpect.spawn_popen.SpawnPopen
doesn't seem to support enough features for our use caseDocumentation
docs
extras and add them to thedev
extra dependencies.dashing
module docstring, while maintaining it without duplication for theOverview
sectionDevelopers
section with the test suite docsGetting Started
guide (still needs work to continue beyond the basics, e.g., example of each family of tiles and how to make your own tile)autosummary
to generate a full API reference, that wouldn't need to be maintained if we add new submodules or restructure the package.furo
, I personally find it less visually cluttering thanalabaster
, and it plays together nicely withsphinx-design
(not added yet) if we want to start including some more modern/Material UI in the docs like tabs, code blocks, badges, buttons, cards, ...